// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Author: wsfuyibing <682805@qq.com>
// Date: 2024-12-10

package filter

import "context"

// Value is a component used to store field expect value(s) for match given v.
type Value interface {
	// GetError return the first error in the error list.
	GetError() error

	// GetField returns the field instance.
	GetField() Field

	// HasError return true if error occurred when parse done.
	HasError() bool

	// Match matches the given value with expect value(s), Return true if match
	// success otherwise false returned.
	Match(ctx context.Context, v any) bool

	// Query returns a filter query expression like sql without field name.
	//
	//   == 1
	//   IN (1, 2, 3)
	Query() string
}
